//! \file IPlugin.h
//! \brief TODO: Document
//!
//! TODO: document
// -----------------------------------------------------------------------------
//! This program is free software; you can redistribute it and/or
//! modify it under the terms of the GNU General Public License
//! as published by the Free Software Foundation; either version 2
//! of the License, or (at your option) any later version.
//!
//! This program is distributed in the hope that it will be useful,
//! but WITHOUT ANY WARRANTY; without even the implied warranty of
//! MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
//! GNU General Public License for more details.
//!
//! You should have received a copy of the GNU General Public License
//! along with this program; if not, write to the Free Software Foundation,
//! Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
// -----------------------------------------------------------------------------

// Project Includes
#include "IPlugin.h"

// Standard Includes
#include <Pluma/Pluma.hpp>

#ifndef CJAGUAR_H_
  #define CJAGUAR_H_

  namespace code_sheriff
  {

    //! \class IPlugin IPlugin.h "IPlugin.h"
    //! \brief TODO: document
    //!
    //! TODO: document
    class CJaguar : public IPlugin
    {

      //========================================================================
      public:
      //========================================================================

        //! \brief TODO: document
        //!
        //! TODO: document
        //!
        //! \param [in] Arg
        //!   TODO: document
        //!
        //! \retval Error
        //!   Error code indicating the result of the requested operation.
        //!
        //! \b Example: \code
        //! TODO: document
        //! \endcode
        std::string getDescription() { return "Jaguar Warrior: soldier of Tezcatlipoca"; }

    };

  // Inherit the plugin provider.
  PLUMA_INHERIT_PROVIDER(CJaguar, IPlugin);

  }  // namespace code_sheriff

#endif // CJAGUAR_H_
